Crear etiqueta

Introducción

Con este método creamos una etiqueta en la compañía del usuario autenticado. Una vez creada, se puede asociar a contactos con el método Asociar etiqueta.

El usuario debe tener el permiso 14 (crear o editar etiquetas), consultar Permisos de un agente.

Para este método debemos agregar un token en Headers de tipo Authorization con el token necesario.

{success} POST: /api/tags

Parámetros

Campo Tipo Requerido Descripción
name string Sí Nombre de la etiqueta
background_color string Sí Color de fondo, en hexadecimal (ej. #d5d5d5)
text_color string Sí Color del texto, en hexadecimal (ej. #000) 

use GuzzleHttp\Client;

$client = new Client();

$res = $client->request("POST", "{$endpoint}/api/tags", [
    "form_params" => [
        "name" => "VIP",
        "background_color" => "/docs/1.0/general/createTag#d5d5d5",
        "text_color" => "/docs/1.0/general/createTag#000"
    ]
]);

$tag = json_decode($res->getBody(), true);

return $tag;

Respuesta correcta

En data.code se retorna el id de la etiqueta creada, que es el que se usa en Asociar etiqueta.

{
    "code": 200,
    "message": "Etiqueta guardada correctamente",
    "data": {
        "code": 6,
        "name": "VIP",
        "background_color": "/docs/1.0/general/createTag#d5d5d5",
        "text_color": "/docs/1.0/general/createTag#000"
    }
}

Respuestas fallidas

Faltan campos:

{
    "code": 400,
    "message": "Faltan campos",
    "errors": {
        "name": [
            "Falta el campo nombre"
        ],
        "background_color": [
            "Falta color de fondo"
        ],
        "text_color": [
            "Falta color de texto"
        ]
    }
}

El usuario no tiene el permiso 14:

{
    "code": 401,
    "message": "Permisos insuficientes para esta acción",
    "errors": {
        "error": [
            "Permisos insuficientes para esta acción"
        ]
    }
}